home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / sorgbr.z / sorgbr
Encoding:
Text File  |  2002-10-03  |  5.1 KB  |  133 lines
  1.  
  2.  
  3.  
  4. SSSSOOOORRRRGGGGBBBBRRRR((((3333SSSS))))                                                          SSSSOOOORRRRGGGGBBBBRRRR((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SORGBR - generate one of the real orthogonal matrices Q or P**T
  10.      determined by SGEBRD when reducing a real matrix A to bidiagonal form
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE SORGBR( VECT, M, N, K, A, LDA, TAU, WORK, LWORK, INFO )
  14.  
  15.          CHARACTER      VECT
  16.  
  17.          INTEGER        INFO, K, LDA, LWORK, M, N
  18.  
  19.          REAL           A( LDA, * ), TAU( * ), WORK( * )
  20.  
  21. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  22.      These routines are part of the SCSL Scientific Library and can be loaded
  23.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  24.      directs the linker to use the multi-processor version of the library.
  25.  
  26.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  27.      4 bytes (32 bits). Another version of SCSL is available in which integers
  28.      are 8 bytes (64 bits).  This version allows the user access to larger
  29.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  30.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  31.      only one of the two versions; 4-byte integer and 8-byte integer library
  32.      calls cannot be mixed.
  33.  
  34. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  35.      SORGBR generates one of the real orthogonal matrices Q or P**T determined
  36.      by SGEBRD when reducing a real matrix A to bidiagonal form: A = Q * B *
  37.      P**T. Q and P**T are defined as products of elementary reflectors H(i) or
  38.      G(i) respectively.
  39.  
  40.      If VECT = 'Q', A is assumed to have been an M-by-K matrix, and Q is of
  41.      order M:
  42.      if m >= k, Q = H(1) H(2) . . . H(k) and SORGBR returns the first n
  43.      columns of Q, where m >= n >= k;
  44.      if m < k, Q = H(1) H(2) . . . H(m-1) and SORGBR returns Q as an M-by-M
  45.      matrix.
  46.  
  47.      If VECT = 'P', A is assumed to have been a K-by-N matrix, and P**T is of
  48.      order N:
  49.      if k < n, P**T = G(k) . . . G(2) G(1) and SORGBR returns the first m rows
  50.      of P**T, where n >= m >= k;
  51.      if k >= n, P**T = G(n-1) . . . G(2) G(1) and SORGBR returns P**T as an
  52.      N-by-N matrix.
  53.  
  54.  
  55. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  56.      VECT    (input) CHARACTER*1
  57.              Specifies whether the matrix Q or the matrix P**T is required, as
  58.              defined in the transformation applied by SGEBRD:
  59.              = 'Q':  generate Q;
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSOOOORRRRGGGGBBBBRRRR((((3333SSSS))))                                                          SSSSOOOORRRRGGGGBBBBRRRR((((3333SSSS))))
  71.  
  72.  
  73.  
  74.              = 'P':  generate P**T.
  75.  
  76.      M       (input) INTEGER
  77.              The number of rows of the matrix Q or P**T to be returned.  M >=
  78.              0.
  79.  
  80.      N       (input) INTEGER
  81.              The number of columns of the matrix Q or P**T to be returned.  N
  82.              >= 0.  If VECT = 'Q', M >= N >= min(M,K); if VECT = 'P', N >= M
  83.              >= min(N,K).
  84.  
  85.      K       (input) INTEGER
  86.              If VECT = 'Q', the number of columns in the original M-by-K
  87.              matrix reduced by SGEBRD.  If VECT = 'P', the number of rows in
  88.              the original K-by-N matrix reduced by SGEBRD.  K >= 0.
  89.  
  90.      A       (input/output) REAL array, dimension (LDA,N)
  91.              On entry, the vectors which define the elementary reflectors, as
  92.              returned by SGEBRD.  On exit, the M-by-N matrix Q or P**T.
  93.  
  94.      LDA     (input) INTEGER
  95.              The leading dimension of the array A. LDA >= max(1,M).
  96.  
  97.      TAU     (input) REAL array, dimension
  98.              (min(M,K)) if VECT = 'Q' (min(N,K)) if VECT = 'P' TAU(i) must
  99.              contain the scalar factor of the elementary reflector H(i) or
  100.              G(i), which determines Q or P**T, as returned by SGEBRD in its
  101.              array argument TAUQ or TAUP.
  102.  
  103.      WORK    (workspace/output) REAL array, dimension (LWORK)
  104.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  105.  
  106.      LWORK   (input) INTEGER
  107.              The dimension of the array WORK. LWORK >= max(1,min(M,N)).  For
  108.              optimum performance LWORK >= min(M,N)*NB, where NB is the optimal
  109.              blocksize.
  110.  
  111.              If LWORK = -1, then a workspace query is assumed; the routine
  112.              only calculates the optimal size of the WORK array, returns this
  113.              value as the first entry of the WORK array, and no error message
  114.              related to LWORK is issued by XERBLA.
  115.  
  116.      INFO    (output) INTEGER
  117.              = 0:  successful exit
  118.              < 0:  if INFO = -i, the i-th argument had an illegal value
  119.  
  120. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  121.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  122.  
  123.      This man page is available only online.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.